. : Region Editor : .
Version 1.0.0.0

     


 . : General Information

The Region Editor is a tool that provides a user interface for defining the regions stored in the regions.xml file. It supports drawing and editing of rectangles defining the region, the go location, priorities and region names. It also provides means of splitting a single regions in subsections through the use of comments.

The Region Editor does not provide you with the code needed to register the region. I might implement some code support feature in a future release, but as for now this program only processes the xml part.

 : .

 . : Using the Region Editor

Most of the time you will open a regions.xml file and edit it. I suggest always keeping a backup of your original file in case something goes wrong (and you delete a facet by mistake ;)).

The program screen is divided in four main areas:

  • The regions structure is a tree located in the top left area. The first level of the tree is compromised of the facets. Each facet has a list of regions which can be host additional subsections.
  • Below the regions tree is the rectangles list, which will display all the rectangles defined for a given region (or subsection)
  • The properties panel is located in the top right area of the screen, and it's a context sensitive area which changes accordingly to what you are working on. It's usually used to change a given item (facet, region, subsection or a single rectangle) as well as add new items.
  • The Map is where the regions are displayed and created. The use of this area is detailed below.

In some cases you will start from scratch. The first thing you need to do is to add one or more facets using the button located under the regions tree. When you create a new facet you also select the base map file used for that facet. Currently, as of AoS, there are 4 map files supported: 0 - Felucca, 1 - Trammel, 2 - Ilshenar, 3 - Malas.

When you select a facet node in the tree, you are given the option to create a new region by specifying its name. Check the focus on region option to automatically move to the region you just created. Likewise, you can add subsections to regions.

 : .

 . : Drawing and managing rectangles

When a region or a subsection is selected in the regions tree you will be able to add rectangles to your region, or to edit the existing ones.

To move the map around right click any location to center the display on that point. You can also zoom in and out.

In order to draw a rectangle single click a location on the map and drag the mouse. When you're happy with the size of the rectangle release the button to finalize the rectangle and add it to the region (or subsection). If you want to move your rectangle, move the mouse button over it and it will change color.

If you wish to change the size of a rectangle, fine tune its location or delete it, you first must select it. Single click it once it's highlighted or select it in the rectangles list to display the rectangle properties in the top area of the window. Use the numeric fields to change the rectangle properties, or the delete button to remove it.

 : .

 . : Setting the Go location for a region
The go location is the point on the map you are taken when you type "[Go RegionName". In order to set this location select the region on the regions tree, then click the Set button near the current go location. The button will change its background. Now click anywhere on the map to set the value. You can right click the map if you need to shift the current view and it won't disrupt the setting process.
 : .

 . : Inns
In order to view, create or edit the inn areas for a region, first select it on the regions tree. Then click the Inns button, which will change its appearance to 'pressed' signaling the Inn editing mode. Now you can draw and edit rectangles as usual. Once you're happy with your inns settings press the Inns button again to return to the region view.
 : .

 . : Understanding subsections

Subsections are a concept I introduced to preserve information contained in XML comments. Splitting a region into subsections is only conceptual and has no real effect on the region. A good example of use of subsections is the moongates region which is defined as follows:

<!-- britain -->
<rect x="1330" y="1991" width="13" height="13" />
- <!-- jhelom -->
<rect x="1494" y="3767" width="12" height="11" />
.......

The server will ignore the comments when reading the region, but the Region Editor will preserve this information by splitting this region into a subsection for each moongate. You can define as many subsections as you wish.

Note that Inns are global for the whole region.

 : .

 . : What this program doesn't do

As far as XML managment is concerned currently this program can be used to tweak everything except:

  • Music
  • Min and Max Z range

I plan on adding those two features soon enough.

As stated before, this program won't register the regions with the server. You will have to do this manually. If you need information about how to do this, look in the \RunUO\Scripts\Regions\ folder or search the RunUO boards. I plan on adding some kind of support for this in the future.

 : .

 . : Support
Support for this software is provided through The Box website.
 : .

 . : Version History
1.0.0.0

August 18, 2003

Initial release features complete editing of the XML tree (except music and min/max z range values).

 : .





This document is based on the fade out web templated created by clouser 2002© and modified by Arya
.: this machine will not communicate :.